Skip to main content

FlowScript Properties

An object defining properties for the FlowScript class.

Key

A unique identifier for the workflow step.

Type: string


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


TypeCode

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

ResumeOnError

Indicates whether the script execution should continue in case of an error. (Marked as obsolete)

Type: bool


ErrorDescriptionObjectName

The name of the object used to store error descriptions. (Marked as obsolete)

Type: string


ErrorOptions

Defines error-related options for the API step.

Type: IFlowErrorOptions


Name

Name for the workflow step.

Type: string


Value

The value or output generated by the script.

Type: object


Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>